/*
 * Copyright 2003,2004 The Apache Software Foundation
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package eu.jakubiak.jpa.translator.discriminator;

/**
 * 
 * 
 * 
 * Zadaniem klasy implementującej interfejs Discriminator 
 * jest wprowadzenie algorytmu który wskaże nam dodatkowy identyfikator
 * w klasie. Wyobrazmy sobie encję:
 * 
 * @Entity
 * Class Hotel {
 *   @Id Long id;
 *   String name;
 *   @Translatable String description;
 * }
 * 
 * Obiekty tej encji będziemy chcieli tłumaczyć. Tłumaczymy tylko kolumnę description.
 * Zapisująć tłumaczenia powinniśmy zapisać przynajmniej: 
 *  - nazwę klasy, 
 *  - nazwę pola, 
 *  - orginalny tekst tłumaczenia,
 *  - tłumaczenie na nowy język.
 * Jednak nie zawsze to wystarczy. Dwa hotele mogą mieć taki sam opis np.: "Fajne"
 * Jednak osoby które tłumaczą teksty na angielski mogą chcię mieć inne tłumaczenie
 * dla każdego z tych hoteli.
 * Konieczne jest więć wskazanie dodatkowej wartości, która odróżnia te hotele.
 * Najprostszy sposób to pobranie hashCode - patrz HashCodeDiscriminator
 * Dla encji JPA możemy też pokusić się o pobranie klucza 
 * kłówengo @Id - patrz JpaDiscriminator
 * 
 * @author Antek
 */
public interface Discriminator{

    /**
     * Calculate hash for object
     * 
     * @param object
     * @return calculated value of hash
     */
    public Long discriminate(Object object);
}
